sdpluginmgr module¶
-
class
sd.api.sdpluginmgr.SDPluginMgr(APIContext, handle, *args, **kwargs)¶ Bases:
sd.api.sdapiobject.SDAPIObjectManages plugins. There is only one SDPluginMgr, that you can retrieve from the SDApplication
-
checkPluginCompatibility(inMetadata: str) → Optional[str]¶ Check if a plugin is compatible with this Designer version
- Parameters
inMetadata – A string with JSON encoded plugin metadata
-
getClassName() → str¶ Returns the most specific name of the class this APIObject is
-
getPlugins() → sd.api.sdarray.SDArray[sd.api.sdplugin.SDPlugin][sd.api.sdplugin.SDPlugin]¶ Get the available plugins
-
getUserPluginsDir() → str¶ Get the user plugins directory
-
loadPlugin(inPluginName: str, inPluginDir: str) → sd.api.sdplugin.SDPlugin¶ Load a plugin
- Parameters
inPluginName – The plugin name
inPluginDir – The directory where the plugin is located
-
release() → None¶ Releases an APIObject
-
unloadPlugin(inPlugin: sd.api.sdplugin.SDPlugin) → None¶ Unload a plugin
- Parameters
inPlugin – The plugin to unload
-